<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<!-- Content Stylesheet for Site -->

        
<!-- start the processing -->
    <!-- ====================================================================== -->
    <!-- Main Page Section -->
    <!-- ====================================================================== -->
    <html>
        <head>
            <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>

                                                    <meta name="author" value="Cort Schaefer">
            <meta name="email" value="cort@xmission.com">
            
           
                                    
            <title>NVelocity - NVelocity</title>
	    <link rel="SHORTCUT ICON" href="..//images/favicon.ico">
	    <link rel="stylesheet" type="text/css" href="..//css/nvelocity.css">

<link rel="stylesheet" type="text/css" href="..//css/nant-task.css">
        </head>

        <body bgcolor="#ffffff" text="#000000" link="#525D76">        
	<table border="0" width="100%" cellspacing="0" ID="Table2">
	    <tr>
		<td align="left">
		    <A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=58632&amp;type=5" width="210" height="62" border="0" alt="SourceForge Logo"></A>
		</td>
		<td align="right">
		    <a href="http://nvelocity.sourceforge.net" style="text-decoration: none;">
			<span class="title">NVelocity</span></a>
		</td>
	    </tr>
	</table>
	<br>


            <table border="0" width="100%" cellspacing="4">
                <tr><td colspan="2">
                    <hr noshade="" size="1"/>
                </td></tr>
                
                <tr>
                    <!-- LEFT SIDE NAVIGATION -->
                    <td width="20%" valign="top" nowrap="true">
                                <p><strong>About</strong></p>
        <ul>
                    <li>    <a href="../index.html">Overview</a>
</li>
                    <li>    <a href="http://sourceforge.net/project/showfiles.php?group_id=58632">Download</a>
</li>
                    <li>    <a href="../changelog.html">ChangeLog</a>
</li>
                </ul>
            <p><strong>Community</strong></p>
        <ul>
                    <li>    <a href="http://sourceforge.net/projects/nvelocity">Project Summary</a>
</li>
                    <li>    <a href="http://sourceforge.net/mail/?group_id=58632">Mailing Lists</a>
</li>
                    <li>    <a href="http://sourceforge.net/cvs/?group_id=58632">CVS Repositories</a>
</li>
                </ul>
            <p><strong>Docs</strong></p>
        <ul>
                    <li>    <a href="../api/overview-summary.html">API Specs</a>
</li>
                    <li>    <a href="../nant/index.html">NAnt Tasks</a>
</li>
                    <li>    <a href="http://jakarta.apache.org/velocity/vtl-reference-guide.html">VTL Reference Guide</a>
</li>
                </ul>
            <p><strong>Related Sites</strong></p>
        <ul>
                    <li>    <a href="http://jakarta.apache.org/velocity">Velocity (the original)</a>
</li>
                    <li>    <a href="http://sourceforge.net/projects/mavnet">Maverick.Net</a>
</li>
                    <li>    <a href="http://sourceforge.net/projects/nant">NAnt</a>
</li>
                </ul>
                        </td>
                    <td width="80%" align="left" valign="top">
                        <h1>texen</h1>
    <p>
	Texen is a general purpose text generating utility. It is capable of producing almost any sort of text output. Driven by NAnt, essentially an NAnt Task, Texen uses a control template, an optional set of worker templates, and control context to govern the generated output. Although TexenTask can be used directly, it is usually subclassed to initialize your control context before generating any output. 
	</p>
    <h3>Parameters</h3>
    <div class="Table-Section">
      <table class="Table">
        <tr>
          <th class="Table-Header">Attribute</th>
          <th class="Table-Header">Description</th>
          <th class="Table-Header" align="left">Required</th>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>controltemplate</td>
          <td class="Table-Cell" align=left>Set the control template for the generating process.</td>
          <td class="Table-Cell" align=left>true</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>outputdirectory</td>
          <td class="Table-Cell" align=left>The directory where new files will be created.</td>
          <td class="Table-Cell" align=left>false</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>templatepath</td>
          <td class="Table-Cell" align=left>This is the path to the templateRoot which is the directory where your site.vsl file is located. This can be defined in the nvelocity.properties or it can be defined here. It it an optional argument if it is defined in the NVelocity properties file already. However, if defined, this value will override the path defined in the nvelocity.properties file.</td>
          <td class="Table-Cell" align=left>true</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>outputfile</td>
          <td class="Table-Cell" align=left>This is the file where the generated text will be placed.</td>
          <td class="Table-Cell" align=left>false</td>
        </tr>
      </table>
    </div>

    <h3>Context Objects</h3>
    <div class="Table-Section">
      <table class="Table">
        <tr>
          <th class="Table-Header">Name</th>
          <th class="Table-Header">Description</th>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$strings</td>
          <td class="Table-Cell" align=left>NVelocity.Util.StringUtils tool, loaded by default texen.properties.</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$files</td>
          <td class="Table-Cell" align=left>NVelocity.NAnt.Texen.FileUtil tool, loaded by default texen.properties.</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$properties</td>
          <td class="Table-Cell" align=left>NVelocity.NAnt.Texen.PropertiesUtil tool, loaded by default texen.properties.</td>
        </tr>
      </table>
    </div>


    <h3>Examples</h3>
    <p class="i1"></p><pre class="code">
&lt;texen
      controlTemplate="Control.vm"
      outputDirectory="."
      templatePath="."
      outputFile="generation.report"
    /&gt;
 </pre>
                    </td>
                </tr>

                <!-- FOOTER -->
                <tr><td colspan="2">
                    <hr noshade="" size="1"/>
                </td></tr>
                <tr><td colspan="2">
                    <div align="center"><font color="#525D76" size="-1">
		    <!-- <em>Copyright &#169; 2002, Cort Schaefer</em> -->
		    </font>
		    </div>
                </td></tr>
            </table>
        </body>
    </html>

<!-- end the processing -->





















